Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[MXNET-1385] Improved Scala Init and Macros warning messages #14656

Merged
merged 4 commits into from
Apr 19, 2019
Merged

[MXNET-1385] Improved Scala Init and Macros warning messages #14656

merged 4 commits into from
Apr 19, 2019

Conversation

lanking520
Copy link
Member

@lanking520 lanking520 commented Apr 9, 2019 •
edited
Loading

Description

Add comprehensive comments on Init and Macros stage for Scala build to get rid of Scala docs warning.
@zachgk @andrewfayres @piyushghai @aaronmarkham

This is the phase 1 for #14081

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

aaronmarkham
aaronmarkham suggested changes Apr 15, 2019
View reviewed changes
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you be consistent with sentence capitalization? I think when displayed in the docs it'll look better if the doc strings are formatted consistently.

Can you flag functions and params with ticks?

Can you cross link to other functions' or params' docs? (not sure if this is possible)

scala-package/macros/src/main/scala/org/apache/mxnet/utils/CToScalaUtils.scala Outdated Show resolved Hide resolved
scala-package/macros/src/main/scala/org/apache/mxnet/utils/CToScalaUtils.scala Outdated Show resolved Hide resolved
scala-package/macros/src/main/scala/org/apache/mxnet/GeneratorBase.scala Outdated Show resolved Hide resolved
scala-package/init/src/main/scala/org/apache/mxnet/init/Base.scala Outdated Show resolved Hide resolved
aaronmarkham
aaronmarkham suggested changes Apr 18, 2019
View reviewed changes
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found some leftover formatting issues... I'm seeing isContrib in a lot of places that probably should be formatted too.

scala-package/init/src/main/scala/org/apache/mxnet/init/LibInfo.scala Outdated Show resolved Hide resolved
scala-package/init/src/main/scala/org/apache/mxnet/init/LibInfo.scala Outdated Show resolved Hide resolved
scala-package/init/src/main/scala/org/apache/mxnet/init/LibInfo.scala Outdated Show resolved Hide resolved
scala-package/init/src/main/scala/org/apache/mxnet/init/LibInfo.scala Outdated Show resolved Hide resolved
scala-package/init/src/main/scala/org/apache/mxnet/init/LibInfo.scala Outdated Show resolved Hide resolved
scala-package/init/src/main/scala/org/apache/mxnet/init/LibInfo.scala Outdated Show resolved Hide resolved
scala-package/macros/src/main/scala/org/apache/mxnet/SymbolMacro.scala Outdated Show resolved Hide resolved
scala-package/macros/src/main/scala/org/apache/mxnet/SymbolMacro.scala Outdated Show resolved Hide resolved
scala-package/macros/src/main/scala/org/apache/mxnet/SymbolMacro.scala Outdated Show resolved Hide resolved
scala-package/macros/src/main/scala/org/apache/mxnet/NDArrayMacro.scala Outdated Show resolved Hide resolved
@lanking520 lanking520 merged commit 153d2f4 into apache:master Apr 19, 2019
kedarbellare pushed a commit to kedarbellare/incubator-mxnet that referenced this pull request Apr 20, 2019
@lanking520 @kedarbellare
[MXNET-1385] Improved Scala Init and Macros warning messages (apache#…
7448429 
…14656)

* 1st phase scala/java warning killers

* add more comments

* Capitialize all starting words of comments

* amend the rest of them
@lanking520 lanking520 deleted the scala-warning-killer branch June 21, 2019 22:11
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
@lanking520
[MXNET-1385] Improved Scala Init and Macros warning messages (apache#…
40d2e61 
…14656)

* 1st phase scala/java warning killers

* add more comments

* Capitialize all starting words of comments

* amend the rest of them
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@aaronmarkham aaronmarkham aaronmarkham approved these changes

@zachgk zachgk zachgk approved these changes

@nswamy nswamy Awaiting requested review from nswamy nswamy is a code owner

@yzhliu yzhliu Awaiting requested review from yzhliu yzhliu is a code owner

Assignees
No one assigned
Labels
Scala
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lanking520 @zachgk @aaronmarkham